Skip to content

refactor: Fix parameters in method endpoints#4300

Merged
gmlewis merged 6 commits into
google:masterfrom
alexandear-org:refactor/requestbody-name
Jun 17, 2026
Merged

refactor: Fix parameters in method endpoints#4300
gmlewis merged 6 commits into
google:masterfrom
alexandear-org:refactor/requestbody-name

Conversation

@alexandear

@alexandear alexandear commented Jun 14, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

This PR adds the paramcheck custom linter that detects issues with body and query parameters. Changes are non-breaking.

The paramcheck does the following:

  • suggests renaming a body parameter to body
  • reports body parameters passed by pointer, because body parameters are usually required
  • reports body parameter types with an Options suffix, because Options are used for query parameters
  • suggests renaming a query struct to opts
  • reports query parameter passed by value, because query parameters are usually optional
  • reports query parameter types without an Options suffix

@codecov

codecov Bot commented Jun 14, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.43182% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.47%. Comparing base (0eacd34) to head (b2ad890).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
github/codespaces_secrets.go 85.71% 0 Missing and 2 partials ⚠️
github/git_refs.go 87.50% 0 Missing and 1 partial ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #4300   +/-   ##
=======================================
  Coverage   97.47%   97.47%           
=======================================
  Files         192      192           
  Lines       19310    19310           
=======================================
  Hits        18822    18822           
  Misses        270      270           
  Partials      218      218

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gmlewis

gmlewis commented Jun 14, 2026

Copy link
Copy Markdown
Collaborator

I'm wondering if we should standardize on an "Options" suffix for query (URL) parameters at the same time since we are standardizing on a "Request" suffix for body parameters?

If so, it seems to me like this new linter is the perfect place to put this.

Thoughts?

@gmlewis gmlewis added the NeedsReview PR is awaiting a review before merging. label Jun 14, 2026
@alexandear

alexandear commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

I'm wondering if we should standardize on an "Options" suffix for query (URL) parameters at the same time since we are standardizing on a "Request" suffix for body parameters?

If so, it seems to me like this new linter is the perfect place to put this.

Thoughts?

Agree, good idea. I'll extend the linter.
Also should think of a better name for the linter.

@alexandear alexandear changed the title refactor: Standardize body parameter names refactor: Fix parameters in method endpoints Jun 16, 2026
@alexandear

alexandear commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

@gmlewis I extended the linter, ready for review.

The linter found a few more problems, created #4301.

gmlewis
gmlewis requested changes Jun 16, 2026
View reviewed changes

@gmlewis gmlewis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @alexandear!
Two tiny nits, otherwise LGTM.

cc: @stevehipwell - @zyfy29 - @Not-Dhananjay-Mishra

Comment thread .custom-gcl.yml
Comment thread .golangci.yml Outdated
Not-Dhananjay-Mishra
Not-Dhananjay-Mishra approved these changes Jun 17, 2026
View reviewed changes

@Not-Dhananjay-Mishra Not-Dhananjay-Mishra left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gmlewis gmlewis removed the NeedsReview PR is awaiting a review before merging. label Jun 17, 2026
@gmlewis

gmlewis commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Thank you, @alexandear and @Not-Dhananjay-Mishra!
Merging.

@gmlewis gmlewis merged commit 3f47638 into google:master Jun 17, 2026
14 checks passed
@alexandear alexandear deleted the refactor/requestbody-name branch June 17, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gmlewis gmlewis gmlewis approved these changes

+1 more reviewer

@Not-Dhananjay-Mishra Not-Dhananjay-Mishra Not-Dhananjay-Mishra approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alexandear @gmlewis @Not-Dhananjay-Mishra